<?php

namespace sffi\WechatRobotPlug\api;

interface MomentApiInterface
{
    /**
     * 获取朋友圈
     * @param string $robotWxid 机器人ID
     * @param string $pyqId 第一条朋友圈的ID，不填默认取最新
     * @param int $num 获取数量
     */
    public function getMoments(int $num, string $pyqId = ''): array;

    /**
     * 点赞朋友圈
     * @param string $robotWxid
     * @param string $id 朋友圈ID
     */
    public function like(string $id): array;

    /**
     * 评论朋友圈
     * @param string $robotWxid
     * @param string $id 朋友圈ID
     * @param string $msg 评论内容
     */
    public function comment(string $id, string $msg): array;

    /**
     * 发朋友圈
     * @param string $robotWxid
     * @param string $xml
     */
    public function sendMoment(string $xml): array;

    /**
     * 发送文本朋友圈
     * @param string $robotWxid
     * @param string $text 内容
     */
    public function sendTextMoment(string $text): array;

    /**
     * 发送图文朋友圈
     * @param string $robotWxid
     * @param string $text 朋友圈文本
     * @param array $imgs 图片数组
     */
    public function sendImageMoment(string $text, array $imgs);

    /**
     * 发送视频朋友圈
     * @param string $robotWxid
     * @param string $text 朋友圈文本
     * @param string $url 视频链接
     */
    public function sendVideoMoment(string $text, string $url);

    /**
     * 分享链接到朋友圈
     * @param string $robotWxid
     * @param string $text 朋友圈内容
     * @param string $title 标题
     * @param string $url 点击链接
     * @param string $imageUrl 图片链接
     */
    public function sendLinkMoment(string $text, string $title, string $url, string $imageUrl);

    /**
     * 获取好友朋友圈
     * @param string $robotWxid
     * @param string $toWxid
     * @param string $id
     * @param int $num
     */
    public function getFriendMoment(string $toWxid, string $id = '', $num = 10);
}